﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed

#pragma once

#include "IGeometry.h"

namespace gcmp
{
    class Intervald;

    /// \brief 曲线
    ///
    class ICurve : public IGeometry
    {
        DEFINE_CAST_DERIVED(gcmp::ICurve, gcmp::IGeometry);
    public:

        /// \brief 设置曲线的参数区间
        /// \param limits    参数区间
        /// \return 成功返回true,否则返回false(默认返回True)
        virtual bool SetLimits(const Intervald &limits) = 0;

        /// \brief 返回曲线的参数区间
        /// \return 曲线的参数区间
        virtual const Intervald GetLimits() const = 0;

        /// \brief 获取曲线的起始参数
        /// \return返回曲线的起始参数
        virtual double GetStartLimit() const = 0;

        /// \brief 获取曲线的终止参数
        /// \return返回曲线的终止参数
        virtual double GetEndLimit() const = 0;

        /// \brief  计算指定参数区间的曲线长度
        /// \param startParameter  参数区间起始值
        /// \param endParameter    参数区间终止值
        /// \return 曲线长度
        virtual double GetLength(double startParameter, double endParameter) const = 0;

        /// \brief 判断曲线是否封闭
        /// \return封闭返回true,否则返回false
        virtual bool IsClosed() const = 0;

        /// \brief 判断曲线是否周期性
        /// \return 周期返回true,否则返回false
        virtual bool IsPeriodic() const = 0;

        /// \brief 曲线反向
        /// \return 成功返回true,否则返回false(默认返回True)
        virtual bool Reverse() = 0;

        /// \brief 是否退化为点
        /// \param epsilon 距离容差
        /// \return 退化为点返回True，否则返回false
        virtual bool IsDegenerated(double epsilon) const = 0;

        /// \brief 计算曲线长度
        /// \return 曲线长度
        virtual double GetLength() const = 0;

        /// \brief      计算曲线上的距离基准参数处点的弧长为给定弧长的点的参数
        /// \param  basedParam          基准参数
        /// \param  arcLength           给定弧长
        /// \param  distanceEpsilon         弧长精度限差
        /// \param parameter           曲线上的给定弧长的点的参数
        /// \param isParamInLimits 求得的参数是否在曲线的参数区间内
        /// \return  成功返回true,否则返回false
        /// \see 内部不处理闭合曲线的情形
        virtual bool GetLengthParam(double basedParam, double arcLength, double& parameter, bool &isParamInLimits, double distanceEpsilon) const = 0;

    public:
        virtual ~ICurve() {}
    };
} 
